home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / lib / ruby / 1.8 / securerandom.rb < prev    next >
Text File  |  2007-10-10  |  4KB  |  138 lines
  1. # = Secure random number generator interface.
  2. #
  3. # This library is an interface for secure random number generator which is
  4. # suitable for generating session key in HTTP cookies, etc.
  5. #
  6. # It supports following secure random number generators.
  7. #
  8. # * openssl
  9. # * /dev/urandom
  10. #
  11. # == Example
  12. #
  13. # # random hexadecimal string.
  14. # p SecureRandom.hex(10) #=> "52750b30ffbc7de3b362"
  15. # p SecureRandom.hex(10) #=> "92b15d6c8dc4beb5f559"
  16. # p SecureRandom.hex(11) #=> "6aca1b5c58e4863e6b81b8"
  17. # p SecureRandom.hex(12) #=> "94b2fff3e7fd9b9c391a2306"
  18. # p SecureRandom.hex(13) #=> "39b290146bea6ce975c37cfc23"
  19. # ...
  20. #
  21. # # random base64 string.
  22. # p SecureRandom.base64(10) #=> "EcmTPZwWRAozdA=="
  23. # p SecureRandom.base64(10) #=> "9b0nsevdwNuM/w=="
  24. # p SecureRandom.base64(10) #=> "KO1nIU+p9DKxGg=="
  25. # p SecureRandom.base64(11) #=> "l7XEiFja+8EKEtY="
  26. # p SecureRandom.base64(12) #=> "7kJSM/MzBJI+75j8"
  27. # p SecureRandom.base64(13) #=> "vKLJ0tXBHqQOuIcSIg=="
  28. # ...
  29. #
  30. # # random binary string.
  31. # p SecureRandom.random_bytes(10) #=> "\016\t{\370g\310pbr\301"
  32. # p SecureRandom.random_bytes(10) #=> "\323U\030TO\234\357\020\a\337"
  33. # ...
  34.  
  35. begin
  36.   require 'openssl'
  37. rescue LoadError
  38. end
  39.  
  40. module SecureRandom
  41.   # SecureRandom.random_bytes generates a random binary string.
  42.   #
  43.   # The argument n specifies the length of the result string.
  44.   #
  45.   # If n is not specified, 16 is assumed.
  46.   # It may be larger in future.
  47.   #
  48.   # If secure random number generator is not available,
  49.   # NotImplementedError is raised.
  50.   def self.random_bytes(n=nil)
  51.     n ||= 16
  52.     if defined? OpenSSL::Random
  53.       return OpenSSL::Random.random_bytes(n)
  54.     end
  55.     if !defined?(@has_urandom) || @has_urandom
  56.       @has_urandom = false
  57.       flags = File::RDONLY
  58.       flags |= File::NONBLOCK if defined? File::NONBLOCK
  59.       flags |= File::NOCTTY if defined? File::NOCTTY
  60.       flags |= File::NOFOLLOW if defined? File::NOFOLLOW
  61.       begin
  62.         File.open("/dev/urandom", flags) {|f|
  63.           unless f.stat.chardev?
  64.             raise Errno::ENOENT
  65.           end
  66.           @has_urandom = true
  67.           ret = f.readpartial(n)
  68.           if ret.length != n
  69.             raise NotImplementedError, "Unexpected partial read from random device"
  70.           end
  71.           return ret
  72.         }
  73.       rescue Errno::ENOENT
  74.         raise NotImplementedError, "No random device"
  75.       end
  76.     end
  77.     raise NotImplementedError, "No random device"
  78.   end
  79.  
  80.   # SecureRandom.hex generates a random hex string.
  81.   #
  82.   # The argument n specifies the length of the random length.
  83.   # The length of the result string is twice of n.
  84.   #
  85.   # If n is not specified, 16 is assumed.
  86.   # It may be larger in future.
  87.   #
  88.   # If secure random number generator is not available,
  89.   # NotImplementedError is raised.
  90.   def self.hex(n=nil)
  91.     random_bytes(n).unpack("H*")[0]
  92.   end
  93.  
  94.   # SecureRandom.base64 generates a random base64 string.
  95.   #
  96.   # The argument n specifies the length of the random length.
  97.   # The length of the result string is about 4/3 of n.
  98.   #
  99.   # If n is not specified, 16 is assumed.
  100.   # It may be larger in future.
  101.   #
  102.   # If secure random number generator is not available,
  103.   # NotImplementedError is raised.
  104.   def self.base64(n=nil)
  105.     [random_bytes(n)].pack("m*").delete("\n")
  106.   end
  107.  
  108.   # SecureRandom.random_number generates a random number.
  109.   #
  110.   # If an positive integer is given as n,
  111.   # SecureRandom.random_number returns an integer:
  112.   # 0 <= SecureRandom.random_number(n) < n.
  113.   #
  114.   # If 0 is given or an argument is not given,
  115.   # SecureRandom.random_number returns an float:
  116.   # 0.0 <= SecureRandom.random_number() < 1.0.
  117.   def self.random_number(n=0)
  118.     if 0 < n
  119.       hex = n.to_s(16)
  120.       hex = '0' + hex if (hex.length & 1) == 1
  121.       bin = [hex].pack("H*")
  122.       mask = bin[0]
  123.       mask |= mask >> 1
  124.       mask |= mask >> 2
  125.       mask |= mask >> 4
  126.       begin
  127.         rnd = SecureRandom.random_bytes(bin.length)
  128.         rnd[0] = (rnd[0] & mask).chr
  129.       end until rnd < bin
  130.       rnd.unpack("H*")[0].hex
  131.     else
  132.       # assumption: Float::MANT_DIG <= 64
  133.       i64 = SecureRandom.random_bytes(8).unpack("Q")[0]
  134.       Math.ldexp(i64 >> (64-Float::MANT_DIG), -Float::MANT_DIG)
  135.     end
  136.   end
  137. end
  138.